<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxEventBatch_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxEventBatch_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Helper struct to submit a batch of events (marks or ranges).  
 <a href="structnvtx_event_batch__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ab94294d1b1bb900a008c2029db2967d1" id="r_ab94294d1b1bb900a008c2029db2967d1"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#ab94294d1b1bb900a008c2029db2967d1">eventSchemaId</a></td></tr>
<tr class="separator:ab94294d1b1bb900a008c2029db2967d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afee23a8f0781cbe9483293172bd2ce07" id="r_afee23a8f0781cbe9483293172bd2ce07"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#afee23a8f0781cbe9483293172bd2ce07">size</a></td></tr>
<tr class="separator:afee23a8f0781cbe9483293172bd2ce07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee58560a3adfde054f0245301cf8d7d4" id="r_aee58560a3adfde054f0245301cf8d7d4"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#aee58560a3adfde054f0245301cf8d7d4">events</a></td></tr>
<tr class="separator:aee58560a3adfde054f0245301cf8d7d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba91014d2831e199e4b3e38b388c181" id="r_a2ba91014d2831e199e4b3e38b388c181"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#a2ba91014d2831e199e4b3e38b388c181">scope</a></td></tr>
<tr class="separator:a2ba91014d2831e199e4b3e38b388c181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12f16213083385276b9cc080100b5197" id="r_a12f16213083385276b9cc080100b5197"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#a12f16213083385276b9cc080100b5197">flags</a></td></tr>
<tr class="separator:a12f16213083385276b9cc080100b5197"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4676ad232d7e62ab7a9aeaceb598429" id="r_af4676ad232d7e62ab7a9aeaceb598429"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#af4676ad232d7e62ab7a9aeaceb598429">flexData</a></td></tr>
<tr class="separator:af4676ad232d7e62ab7a9aeaceb598429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bed0017d4177f4bbbb6dac5ec70bafb" id="r_a6bed0017d4177f4bbbb6dac5ec70bafb"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#a6bed0017d4177f4bbbb6dac5ec70bafb">flexDataSize</a></td></tr>
<tr class="separator:a6bed0017d4177f4bbbb6dac5ec70bafb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a029e6d18671052add9f6d94aaa6bf379" id="r_a029e6d18671052add9f6d94aaa6bf379"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_event_batch__t.html#a029e6d18671052add9f6d94aaa6bf379">flexDataOffset</a></td></tr>
<tr class="separator:a029e6d18671052add9f6d94aaa6bf379"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper struct to submit a batch of events (marks or ranges). </p>
<p>By default, events are assumed to be chronologically sorted by the first timestamp in the event (start time in a range). If the events are not sorted, the <code>flags</code> field must be set accordingly (see <code>NVTX_BATCH_FLAG_*</code>). </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00989">989</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aee58560a3adfde054f0245301cf8d7d4" name="aee58560a3adfde054f0245301cf8d7d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee58560a3adfde054f0245301cf8d7d4">&#9670;&#160;</a></span>events</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* nvtxEventBatch_t::events</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the array of deferred events. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01004">1004</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ab94294d1b1bb900a008c2029db2967d1" name="ab94294d1b1bb900a008c2029db2967d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab94294d1b1bb900a008c2029db2967d1">&#9670;&#160;</a></span>eventSchemaId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxEventBatch_t::eventSchemaId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Identifier of the data layout of a deferred event in the array of events. Only layouts with static payload size are allowed. The size of an event in the array is specified by the static payload size during the schema registration. The time domain of event timestamps is provided via time semantics in the schema registration. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00998">998</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a12f16213083385276b9cc080100b5197" name="a12f16213083385276b9cc080100b5197"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12f16213083385276b9cc080100b5197">&#9670;&#160;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxEventBatch_t::flags</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Timestamp ordering (sorted, partially sorted, unsorted), etc. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01010">1010</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="af4676ad232d7e62ab7a9aeaceb598429" name="af4676ad232d7e62ab7a9aeaceb598429"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4676ad232d7e62ab7a9aeaceb598429">&#9670;&#160;</a></span>flexData</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* nvtxEventBatch_t::flexData</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Flexible data which can be referenced by events in the batch. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01013">1013</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a029e6d18671052add9f6d94aaa6bf379" name="a029e6d18671052add9f6d94aaa6bf379"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a029e6d18671052add9f6d94aaa6bf379">&#9670;&#160;</a></span>flexDataOffset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxEventBatch_t::flexDataOffset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Offset from the <code>flexData</code> pointer to the begin of the flexible data in bytes. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01022">1022</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a6bed0017d4177f4bbbb6dac5ec70bafb" name="a6bed0017d4177f4bbbb6dac5ec70bafb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bed0017d4177f4bbbb6dac5ec70bafb">&#9670;&#160;</a></span>flexDataSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxEventBatch_t::flexDataSize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of the flexible data memory blob. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01016">1016</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a2ba91014d2831e199e4b3e38b388c181" name="a2ba91014d2831e199e4b3e38b388c181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ba91014d2831e199e4b3e38b388c181">&#9670;&#160;</a></span>scope</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxEventBatch_t::scope</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Scope of all events or counters in the batch. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01007">1007</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="afee23a8f0781cbe9483293172bd2ce07" name="afee23a8f0781cbe9483293172bd2ce07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afee23a8f0781cbe9483293172bd2ce07">&#9670;&#160;</a></span>size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxEventBatch_t::size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of the array of deferred events (in bytes). </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l01001">1001</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
